/*
 *  Copyright (C) 2010 Glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.balisunrise.common.VisualEntityType;

/**
 * Esta anotação representa a ação de cancelamento para editores e buscas.
 *
 * @author Glauco
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface ActionCancel {

    /**
     * Representa os nomes para construção da ação.
     * @return Retorna um array de nomes para esta definição de uma ação.
     */
    public String[] alias();

    /**
     * Texto para identificação da ação.
     * @return
     */
    public String text();

    /**
     * Texto de explicação da ação.
     * @return
     */
    public String toolTipText();

    /**
     * Tipos de VisualEntity que possuem o evento ou ação.
     * Não informando os valores será atribuido a todos.
     *
     * @return Array de tipos de VisualEntity validos para o evento ou ação.
     */
    public VisualEntityType[] target() default {};
}
